<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"> <style>
	.KEYW {color: #933;}
	.COMM {color: #bbb; font-style: italic;}
	.NUMB {color: #393;}
	.STRN {color: #393;}
	.REGX {color: #339;}
	.line {border-right: 1px dotted #666; color: #666; font-style: normal;}
	</style></head><body><pre><span class='line'>  1</span> <span class="COMM">/**
<span class='line'>  2</span>  * Work with access tickets.
<span class='line'>  3</span>  *
<span class='line'>  4</span>  * The protocol control access to server resources using access tickets.
<span class='line'>  5</span>  *   A client must explicitly request access tickets before doing work.
<span class='line'>  6</span>  *   An access ticket grants a client the right to use a specific set of
<span class='line'>  7</span>  *   resources - called a "realm" - in specific ways.
<span class='line'>  8</span>  *
<span class='line'>  9</span>  * @name Access
<span class='line'> 10</span>  * @exports Access as api.Access
<span class='line'> 11</span>  * @class
<span class='line'> 12</span>  */</span><span class="WHIT">
<span class='line'> 13</span> 
<span class='line'> 14</span> 
<span class='line'> 15</span> </span><span class="COMM">/**
<span class='line'> 16</span>  * Grant access to server resources.
<span class='line'> 17</span>  *
<span class='line'> 18</span>  * This method provides the client with an access ticket. The access
<span class='line'> 19</span>  *     ticket is valid within the current channel and for the lifespan of
<span class='line'> 20</span>  *     the channel.
<span class='line'> 21</span>  *
<span class='line'> 22</span>  * @name Access#requestOk
<span class='line'> 23</span>  * @event
<span class='line'> 24</span>  * @param {Number} ticket An access ticket granted by the server for a certain set of access
<span class='line'> 25</span>  *     rights within a specific realm. Access tickets are valid within the
<span class='line'> 26</span>  *     channel where they were created, and expire when the channel closes.
<span class='line'> 27</span>  */</span><span class="WHIT">
<span class='line'> 28</span> 
<span class='line'> 29</span> 
<span class='line'> 30</span> 
<span class='line'> 31</span> </span><span class="COMM">/**
<span class='line'> 32</span>  * Request an access ticket.
<span class='line'> 33</span>  *
<span class='line'> 34</span>  * This method requests an access ticket for an access realm.
<span class='line'> 35</span>  *     The server responds by granting the access ticket.  If the
<span class='line'> 36</span>  *     client does not have access rights to the requested realm
<span class='line'> 37</span>  *     this causes a connection exception.  Access tickets are a
<span class='line'> 38</span>  *     per-channel resource.
<span class='line'> 39</span>  *
<span class='line'> 40</span>  * @name Access#request
<span class='line'> 41</span>  * @function
<span class='line'> 42</span>  * @param {String} realm Must start with a slash "/" and continue with path names
<span class='line'> 43</span>  *   separated by slashes. A path name consists of any combination
<span class='line'> 44</span>  *   of at least one of [A-Za-z0-9] plus zero or more of [.-_+!=:].
<span class='line'> 45</span>  * @param {Boolean} exclusive Request exclusive access to the realm. If the server cannot grant
<span class='line'> 46</span>  *       this - because there are other active tickets for the realm - it
<span class='line'> 47</span>  *       raises a channel exception.
<span class='line'> 48</span>  * @param {Boolean} passive Request message passive access to the specified access realm.
<span class='line'> 49</span>  *       Passive access lets a client get information about resources in
<span class='line'> 50</span>  *       the realm but not to make any changes to them.
<span class='line'> 51</span>  * @param {Boolean} active Request message active access to the specified access realm.
<span class='line'> 52</span>  *       Acvtive access lets a client get create and delete resources in
<span class='line'> 53</span>  *       the realm.
<span class='line'> 54</span>  * @param {Boolean} write Request write access to the specified access realm.  Write access
<span class='line'> 55</span>  *       lets a client publish messages to all exchanges in the realm.
<span class='line'> 56</span>  * @param {Boolean} read Request read access to the specified access realm.  Read access
<span class='line'> 57</span>  *       lets a client consume messages from queues in the realm.
<span class='line'> 58</span>  */</span><span class="WHIT">
<span class='line'> 59</span> 
<span class='line'> 60</span> </span></pre></body></html>